/*
 * Copyright 2009 (c) Patrick Pietens.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package indigo.events
{
	import flash.events.Event;

	/**
	 * The <code>PropertyChangeEvent</code> class defines events that are 
	 * associated with the <code>BindableObject</code> class. These include the 
	 * following events:
	 * 
	 * <p>
	 * <code>PropertyChangeEvent.ADDED</code>: Dispatches when a property is 
	 * added to a <code>BindableObject</code><br/>
	 * <code>PropertyChangeEvent.CHANGED</code>: Dispatches when a property is 
	 * changed in a <code>BindableObject</code><br/>
	 * <code>PropertyChangeEvent.UNCHANGED</code>: Dispatches when a property 
	 * is set but unchanged in a <code>BindableObject</code><br/>
	 * <code>PropertyChangeEvent.DELETED</code>: Dispatches when a property is 
	 * deleted from a <code>BindableObject</code>
	 * </p>
	 * 
	 * @playerversion Flash 9
	 * @langversion ActionScript 3.0
	 * 
	 * @see	indigo.model.BindableObject
	 */
	public class PropertyChangeEvent extends Event
	{
		/**
		 * Dispatches when a property is added to a <code>BindableObject</code>
		 */
		public static const ADDED:String = "added";
		/**
		 * Dispatches when a property is changed in a <code>BindableObject</code>
		 */
		public static const CHANGED:String = "changed";
		/**
		 * Dispatches when a property is set but unchanged in a 
		 * <code>BindableObject</code>
		 */
		public static const UNCHANGED:String = "unchanged";
		/**
		 * Dispatches when a property is deleted from a 
		 * <code>BindableObject</code>
		 */
		public static const DELETED:String = "deleted";
		/**
		 * String that indicates the property that is updated
		 */
		public var property:String;
		/**
		 * Object that represents the current value of the property
		 */
		public var newValue:*;
		/**
		 * Object that represents the old value of the property
		 */
		public var oldValue:*;


		/**
		 * Constructor
		 *
		 */
		public function PropertyChangeEvent( type:String, bubbles:Boolean = false, cancelable:Boolean = false )
		{
			super( type, bubbles, cancelable );
		}


		/**
		 * @inheritDoc
		 * 
		 */
		override public function clone():Event
		{
			var myEvent:PropertyChangeEvent = new PropertyChangeEvent( this.type, this.bubbles, this.cancelable );
			myEvent.property = this.property;
			myEvent.newValue = this.newValue;
			myEvent.oldValue = this.oldValue;
			return myEvent;
		}


		/**
		 * @inheritDoc
		 * 
		 */
		override public function toString():String
		{
			return "[PropertyEvent " + "type='" + this.type + "' " + "bubbles='" + this.bubbles + "' " + "cancelable='" + this.cancelable + "' " + "property='" + this.property + "' " + "newValue='" + this.newValue + "' " + "oldValue='" + this.oldValue + "' " + "]";
		}
	}
}